/*******************************************************************************
 * Copyright IBM Corp. and others 2022
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution and
 * is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following
 * Secondary Licenses when the conditions for such availability set
 * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
 * General Public License, version 2 with the GNU Classpath
 * Exception [1] and GNU General Public License, version 2 with the
 * OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] https://openjdk.org/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 *******************************************************************************/

#ifndef TR_COMPILEBEFORECHECKPOINT_INCL
#define TR_COMPILEBEFORECHECKPOINT_INCL

#include "j9cfg.h"

#if defined(J9VM_OPT_CRIU_SUPPORT)

struct J9JavaVM;
struct J9VMThread;
struct J9Method;

namespace TR { class Region; }
namespace TR { class CompilationInfo; }
class TR_J9VMBase;

namespace TR
{

class CompileBeforeCheckpoint
   {
   public:

   CompileBeforeCheckpoint(TR::Region &region, J9VMThread *vmThread, TR_J9VMBase *fej9, TR::CompilationInfo *compInfo);

   /**
    * @brief API to trigger compilation in the pre-checkpoint hook.
    *
    *        This method is called with the Comp Monitor in hand.
    */
   void compileMethodsBeforeCheckpoint();

   private:

   /**
    * @brief Queue the specified method for compilation
    *
    *        This method is called with the CR Runtime Monitor in hand. However,
    *        it releases it before actually queueing the method for compilation
    *        and reacquires it before returning.
    *
    * @param j9method the J9Method
    */
   void queueMethodForCompilationBeforeCheckpoint(J9Method *j9method, bool recomp = false);

   /**
    * @brief Iterates over the list of methods to be compiled proactively
    *
    *        This method is called with VMAccess in hand.
    */
   void queueMethodsForCompilationBeforeCheckpoint();

   TR::Region &_region;
   J9VMThread *_vmThread;
   TR_J9VMBase *_fej9;
   TR::CompilationInfo *_compInfo;
   };

}
#endif // #if defined(J9VM_OPT_CRIU_SUPPORT)

#endif // TR_COMPILEBEFORECHECKPOINT_INCL
